<meta charset="utf-8">
(#) ListenableWorkers constructed using the default WorkerFactories need to be public

!!! ERROR: ListenableWorkers constructed using the default WorkerFactories need to be public
   This is an error, and is also enforced at build time when
   supported by the build system. For Android this means it will
   run during release builds.

Id
:   `WorkerHasAPublicModifier`
Summary
:   ListenableWorkers constructed using the default WorkerFactories need to be public
Severity
:   Fatal
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Identifier
:   androidx.work
Feedback
:   https://issuetracker.google.com/issues/new?component=409906
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.7+
Artifact
:   [androidx.work:work-runtime](androidx_work_work-runtime.md.html)
Since
:   2.4.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/main/java/androidx/work/lint/WorkerHasPublicModifierDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/WorkerHasPublicModifierDetectorTest.kt)
Copyright Year
:   2020

When you define a ListenableWorker which is constructed using the
default WorkerFactory, the ListenableWorker sub-type needs to be
public.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
com/example/Worker.kt:5:Error: com.example.Worker needs to be public
[WorkerHasAPublicModifier]
private class Worker: ListenableWorker()
              ------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`com/example/Worker.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package com.example

import androidx.work.ListenableWorker

private class Worker: ListenableWorker()
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/WorkerHasPublicModifierDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `WorkerHasPublicModifierDetector.testWithPrivateWorker`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=409906.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.work:work-runtime:2.10.0")

// build.gradle
implementation 'androidx.work:work-runtime:2.10.0'

// build.gradle.kts with version catalogs:
implementation(libs.work.runtime)

# libs.versions.toml
[versions]
work-runtime = "2.10.0"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
work-runtime = {
    module = "androidx.work:work-runtime",
    version.ref = "work-runtime"
}
```

2.10.0 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.work:work-runtime](androidx_work_work-runtime.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("WorkerHasAPublicModifier")
  fun method() {
     setWorkerFactory(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("WorkerHasAPublicModifier")
  void method() {
     setWorkerFactory(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection WorkerHasAPublicModifier
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="WorkerHasAPublicModifier" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'WorkerHasAPublicModifier'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore WorkerHasAPublicModifier ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>